home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / cdity / ClipTool38_1.lha / ClipTool / docs / cliptool.doc next >
Text File  |  1995-01-03  |  32KB  |  842 lines
  1. This file documents ClipTool.
  2.  
  3.    Copyright (C) 1994 Torsten Poulin
  4.  
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.  
  9.    Permission is granted to copy and distribute modified versions of
  10. this manual under the conditions for verbatim copying, provided also
  11. that the sections entitled "Distribution" and "GNU General Public
  12. License" are included exactly as in the original, and provided that the
  13. entire resulting derived work is distributed under the terms of a
  14. permission notice identical to this one.
  15.  
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that the sections entitled "Distribution" and "GNU
  19. General Public License" may be included in a translation approved by
  20. the author instead of in the original English.
  21.  
  22.  
  23. ClipTool V38.1
  24. **************
  25.  
  26. ClipTool is a Commodities Exchange program that among other things is a
  27. graphic user interface to the Amiga system clipboard. It can function as
  28. a storehouse for multiple text clips and it can use all the clipboard
  29. units; thus you can move data from one unit to another. It is also
  30. possible to load and save data to and from the clipboard. Its convenient
  31. ARexx interface makes it easy to operate it by remote control. A simple
  32. example script that shows how clipboard support can be added to the Ed
  33. text editor is included.
  34.  
  35.    [This is an unfinished version of the documentation.  ClipTool was
  36. intended as the prototype of a more ambitious clipboard tool, capable of
  37. handling graphics, having scrollbars so you could move around the
  38. clipped data, etc. Nothing has been done about the code and this
  39. document for almost a year and I haven't got time to work on them in the
  40. foreseeable future.  For that reason, I have decided to release the
  41. "package" in its unfinished state, hoping that somebody will pick it up
  42. and improve it.
  43.  
  44.    Torsten  (2-Jan-95)]
  45.  
  46.  
  47. Distribution
  48. *************
  49.  
  50. ClipTool is "free"; this means that everyone is free to use it and free
  51. to redistribute it on a free basis. ClipTool is not in the public
  52. domain; it is copyrighted and there are restrictions on its
  53. distribution, but these restrictions are designed to permit everything
  54. that a good cooperating citizen would want to do. What is not allowed
  55. is to try to prevent others from further sharing any version of ClipTool
  56. that they might get from you. The precise conditions are found in the
  57. GNU General Public License that comes with ClipTool and also appears
  58. following this section.
  59.  
  60. The easiest way to get a copy of ClipTool is from someone else who has
  61. it. You need not ask for permission to do so, or tell any one else;
  62. just copy it.
  63.  
  64. If you have access to the Internet, you can get the latest distribution
  65. version of ClipTool from Aminet:
  66.  
  67.     Scandinavia
  68.           `ftp.luth.se'
  69.  
  70.     Switzerland
  71.           `litamiga.epfl.ch'
  72.  
  73.     Germany
  74.           `ftp.uni-kl.de'
  75.           `ftp.uni-erlangen.de'
  76.           `ftp.cs.tu-berlin.de'
  77.           `ftp.uni-paderborn.de'
  78.  
  79.     USA
  80.           `ftp.etsu.edu'
  81.           `wuarchive.wustl.edu'
  82.  
  83.     UK
  84.           `src.doc.ic.ac.uk'
  85.  
  86.     Australia
  87.           `splat.aarnet.edu.au'
  88.  
  89.    Most of these sites delete old files, however `wuarchive.wustl.edu'
  90. and `ftp.luth.se' keep all files.
  91.  
  92.  
  93. GNU General Public License
  94. ***************************
  95.  
  96.                          Version 2, June 1991
  97.  
  98.      Copyright (C) 1989, 1991 Free Software Foundation, Inc.
  99.      675 Mass Ave, Cambridge, MA 02139, USA
  100.      
  101.      Everyone is permitted to copy and distribute verbatim copies
  102.      of this license document, but changing it is not allowed.
  103.  
  104. Preamble
  105. ========
  106.  
  107. The licenses for most software are designed to take away your freedom
  108. to share and change it. By contrast, the GNU General Public License is
  109. intended to guarantee your freedom to share and change free
  110. software--to make sure the software is free for all its users. This
  111. General Public License applies to most of the Free Software
  112. Foundation's software and to any other program whose authors commit to
  113. using it. (Some other Free Software Foundation software is covered by
  114. the GNU Library General Public License instead.) You can apply it to
  115. your programs, too.
  116.  
  117. When we speak of free software, we are referring to freedom, not price.
  118. Our General Public Licenses are designed to make sure that you have the
  119. freedom to distribute copies of free software (and charge for this
  120. service if you wish), that you receive source code or can get it if you
  121. want it, that you can change the software or use pieces of it in new
  122. free programs; and that you know you can do these things.
  123.  
  124. To protect your rights, we need to make restrictions that forbid anyone
  125. to deny you these rights or to ask you to surrender the rights. These
  126. restrictions translate to certain responsibilities for you if you
  127. distribute copies of the software, or if you modify it.
  128.  
  129. For example, if you distribute copies of such a program, whether gratis
  130. or for a fee, you must give the recipients all the rights that you
  131. have. You must make sure that they, too, receive or can get the source
  132. code. And you must show them these terms so they know their rights.
  133.  
  134. We protect your rights with two steps: (1) copyright the software, and
  135. (2) offer you this license which gives you legal permission to copy,
  136. distribute and/or modify the software.
  137.  
  138. Also, for each author's protection and ours, we want to make certain
  139. that everyone understands that there is no warranty for this free
  140. software. If the software is modified by someone else and passed on, we
  141. want its recipients to know that what they have is not the original, so
  142. that any problems introduced by others will not reflect on the original
  143. authors' reputations.
  144.  
  145. Finally, any free program is threatened constantly by software patents.
  146. We wish to avoid the danger that redistributors of a free program will
  147. individually obtain patent licenses, in effect making the program
  148. proprietary. To prevent this, we have made it clear that any patent
  149. must be licensed for everyone's free use or not licensed at all.
  150.  
  151. The precise terms and conditions for copying, distribution and
  152. modification follow.
  153.  
  154.                          TERMS AND CONDITIONS
  155.  
  156.   1. This License applies to any program or other work which contains a
  157.      notice placed by the copyright holder saying it may be distributed
  158.      under the terms of this General Public License. The "Program",
  159.      below, refers to any such program or work, and a "work based on
  160.      the Program" means either the Program or any derivative work under
  161.      copyright law: that is to say, a work containing the Program or a
  162.      portion of it, either verbatim or with modifications and/or
  163.      translated into another language. (Hereinafter, translation is
  164.      included without limitation in the term "modification".) Each
  165.      licensee is addressed as "you".
  166.  
  167.      Activities other than copying, distribution and modification are
  168.      not covered by this License; they are outside its scope. The act of
  169.      running the Program is not restricted, and the output from the
  170.      Program is covered only if its contents constitute a work based on
  171.      the Program (independent of having been made by running the
  172.      Program). Whether that is true depends on what the Program does.
  173.  
  174.   2. You may copy and distribute verbatim copies of the Program's
  175.      source code as you receive it, in any medium, provided that you
  176.      conspicuously and appropriately publish on each copy an appropriate
  177.      copyright notice and disclaimer of warranty; keep intact all the
  178.      notices that refer to this License and to the absence of any
  179.      warranty; and give any other recipients of the Program a copy of
  180.      this License along with the Program.
  181.  
  182.      You may charge a fee for the physical act of transferring a copy,
  183.      and you may at your option offer warranty protection in exchange
  184.      for a fee.
  185.  
  186.   3. You may modify your copy or copies of the Program or any portion
  187.      of it, thus forming a work based on the Program, and copy and
  188.      distribute such modifications or work under the terms of Section 2
  189.      above, provided that you also meet all of these conditions:
  190.  
  191.         * You must cause the modified files to carry prominent notices
  192.           stating that you changed the files and the date of any change.
  193.  
  194.         * You must cause any work that you distribute or publish, that
  195.           in whole or in part contains or is derived from the Program
  196.           or any part thereof, to be licensed as a whole at no charge
  197.           to all third parties under the terms of this License.
  198.  
  199.         * If the modified program normally reads commands interactively
  200.           when run, you must cause it, when started running for such
  201.           interactive use in the most ordinary way, to print or display
  202.           an announcement including an appropriate copyright notice and
  203.           a notice that there is no warranty (or else, saying that you
  204.           provide a warranty) and that users may redistribute the
  205.           program under these conditions, and telling the user how to
  206.           view a copy of this License. (Exception: if the Program
  207.           itself is interactive but does not normally print such an
  208.           announcement, your work based on the Program is not required
  209.           to print an announcement.)
  210.  
  211.      These requirements apply to the modified work as a whole. If
  212.      identifiable sections of that work are not derived from the
  213.      Program, and can be reasonably considered independent and separate
  214.      works in themselves, then this License, and its terms, do not
  215.      apply to those sections when you distribute them as separate
  216.      works. But when you distribute the same sections as part of a
  217.      whole which is a work based on the Program, the distribution of
  218.      the whole must be on the terms of this License, whose permissions
  219.      for other licensees extend to the entire whole, and thus to each
  220.      and every part regardless of who wrote it.
  221.  
  222.      Thus, it is not the intent of this section to claim rights or
  223.      contest your rights to work written entirely by you; rather, the
  224.      intent is to exercise the right to control the distribution of
  225.      derivative or collective works based on the Program.
  226.  
  227.      In addition, mere aggregation of another work not based on the
  228.      Program with the Program (or with a work based on the Program) on
  229.      a volume of a storage or distribution medium does not bring the
  230.      other work under the scope of this License.
  231.  
  232.   4. You may copy and distribute the Program (or a work based on it,
  233.      under Section 3) in object code or executable form under the terms
  234.      of Sections 2 and 3 above provided that you also do one of the
  235.      following:
  236.  
  237.         * Accompany it with the complete corresponding machine-readable
  238.           source code, which must be distributed under the terms of
  239.           Sections 2 and 3 above on a medium customarily used for
  240.           software interchange; or,
  241.  
  242.         * Accompany it with a written offer, valid for at least three
  243.           years, to give any third party, for a charge no more than your
  244.           cost of physically performing source distribution, a complete
  245.           machine-readable copy of the corresponding source code, to be
  246.           distributed under the terms of Sections 2 and 3 above on a
  247.           medium customarily used for software interchange; or,
  248.  
  249.         * Accompany it with the information you received as to the offer
  250.           to distribute corresponding source code. (This alternative is
  251.           allowed only for noncommercial distribution and only if you
  252.           received the program in object code or executable form with
  253.           such an offer, in accord with the previous Subsection.)
  254.  
  255.      The source code for a work means the preferred form of the work for
  256.      making modifications to it. For an executable work, complete source
  257.      code means all the source code for all modules it contains, plus
  258.      any associated interface definition files, plus the scripts used to
  259.      control compilation and installation of the executable. However,
  260.      as a special exception, the source code distributed need not
  261.      include anything that is normally distributed (in either source or
  262.      binary form) with the major components (compiler, kernel, and so
  263.      on) of the operating system on which the executable runs, unless
  264.      that component itself accompanies the executable.
  265.  
  266.      If distribution of executable or object code is made by offering
  267.      access to copy from a designated place, then offering equivalent
  268.      access to copy the source code from the same place counts as
  269.      distribution of the source code, even though third parties are not
  270.      compelled to copy the source along with the object code.
  271.  
  272.   5. You may not copy, modify, sublicense, or distribute the Program
  273.      except as expressly provided under this License. Any attempt
  274.      otherwise to copy, modify, sublicense or distribute the Program is
  275.      void, and will automatically terminate your rights under this
  276.      License. However, parties who have received copies, or rights,
  277.      from you under this License will not have their licenses
  278.      terminated so long as such parties remain in full compliance.
  279.  
  280.   6. You are not required to accept this License, since you have not
  281.      signed it. However, nothing else grants you permission to modify or
  282.      distribute the Program or its derivative works. These actions are
  283.      prohibited by law if you do not accept this License. Therefore, by
  284.      modifying or distributing the Program (or any work based on the
  285.      Program), you indicate your acceptance of this License to do so,
  286.      and all its terms and conditions for copying, distributing or
  287.      modifying the Program or works based on it.
  288.  
  289.   7. Each time you redistribute the Program (or any work based on the
  290.      Program), the recipient automatically receives a license from the
  291.      original licensor to copy, distribute or modify the Program
  292.      subject to these terms and conditions. You may not impose any
  293.      further restrictions on the recipients' exercise of the rights
  294.      granted herein. You are not responsible for enforcing compliance
  295.      by third parties to this License.
  296.  
  297.   8. If, as a consequence of a court judgment or allegation of patent
  298.      infringement or for any other reason (not limited to patent
  299.      issues), conditions are imposed on you (whether by court order,
  300.      agreement or otherwise) that contradict the conditions of this
  301.      License, they do not excuse you from the conditions of this
  302.      License. If you cannot distribute so as to satisfy simultaneously
  303.      your obligations under this License and any other pertinent
  304.      obligations, then as a consequence you may not distribute the
  305.      Program at all. For example, if a patent license would not permit
  306.      royalty-free redistribution of the Program by all those who
  307.      receive copies directly or indirectly through you, then the only
  308.      way you could satisfy both it and this License would be to refrain
  309.      entirely from distribution of the Program.
  310.  
  311.      If any portion of this section is held invalid or unenforceable
  312.      under any particular circumstance, the balance of the section is
  313.      intended to apply and the section as a whole is intended to apply
  314.      in other circumstances.
  315.  
  316.      It is not the purpose of this section to induce you to infringe any
  317.      patents or other property right claims or to contest validity of
  318.      any such claims; this section has the sole purpose of protecting
  319.      the integrity of the free software distribution system, which is
  320.      implemented by public license practices. Many people have made
  321.      generous contributions to the wide range of software distributed
  322.      through that system in reliance on consistent application of that
  323.      system; it is up to the author/donor to decide if he or she is
  324.      willing to distribute software through any other system and a
  325.      licensee cannot impose that choice.
  326.  
  327.      This section is intended to make thoroughly clear what is believed
  328.      to be a consequence of the rest of this License.
  329.  
  330.   9. If the distribution and/or use of the Program is restricted in
  331.      certain countries either by patents or by copyrighted interfaces,
  332.      the original copyright holder who places the Program under this
  333.      License may add an explicit geographical distribution limitation
  334.      excluding those countries, so that distribution is permitted only
  335.      in or among countries not thus excluded. In such case, this
  336.      License incorporates the limitation as if written in the body of
  337.      this License.
  338.  
  339.  10. The Free Software Foundation may publish revised and/or new
  340.      versions of the General Public License from time to time. Such new
  341.      versions will be similar in spirit to the present version, but may
  342.      differ in detail to address new problems or concerns.
  343.  
  344.  11. Each version is given a distinguishing version number. If the
  345.      Program specifies a version number of this License which applies
  346.      to it and "any later version", you have the option of following
  347.      the terms and conditions either of that version or of any later
  348.      version published by the Free Software Foundation. If the Program
  349.      does not specify a version number of this License, you may choose
  350.      any version ever published by the Free Software Foundation.
  351.  
  352.  12. If you wish to incorporate parts of the Program into other free
  353.      programs whose distribution conditions are different, write to the
  354.      author to ask for permission. For software which is copyrighted by
  355.      the Free Software Foundation, write to the Free Software
  356.      Foundation; we sometimes make exceptions for this. Our decision
  357.      will be guided by the two goals of preserving the free status of
  358.      all derivatives of our free software and of promoting the sharing
  359.      and reuse of software generally.
  360.  
  361.                                 NO WARRANTY
  362.  
  363.  13. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
  364.      WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  365.      LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
  366.      AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
  367.      OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  368.      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  369.      FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
  370.      PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
  371.      DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR
  372.      OR CORRECTION.
  373.  
  374.  14. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  375.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  376.      MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
  377.      LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  378.      INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
  379.      INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
  380.      DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
  381.      OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
  382.      OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
  383.      ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  384.  
  385.                       END OF TERMS AND CONDITIONS
  386.  
  387. Appendix: How to Apply These Terms to Your New Programs
  388. =======================================================
  389.  
  390. If you develop a new program, and you want it to be of the greatest
  391. possible use to the public, the best way to achieve this is to make it
  392. free software which everyone can redistribute and change under these
  393. terms.
  394.  
  395. To do so, attach the following notices to the program. It is safest to
  396. attach them to the start of each source file to most effectively convey
  397. the exclusion of warranty; and each file should have at least the
  398. "copyright" line and a pointer to where the full notice is found.
  399.  
  400.      ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
  401.      Copyright (C) 19YY  NAME OF AUTHOR
  402.      
  403.      This program is free software; you can redistribute it and/or modify
  404.      it under the terms of the GNU General Public License as published by
  405.      the Free Software Foundation; either version 2 of the License, or
  406.      (at your option) any later version.
  407.      
  408.      This program is distributed in the hope that it will be useful,
  409.      but WITHOUT ANY WARRANTY; without even the implied warranty of
  410.      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  411.      GNU General Public License for more details.
  412.      
  413.      You should have received a copy of the GNU General Public License
  414.      along with this program; if not, write to the Free Software
  415.      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  416.  
  417. Also add information on how to contact you by electronic and paper mail.
  418.  
  419. If the program is interactive, make it output a short notice like this
  420. when it starts in an interactive mode:
  421.  
  422.      Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR
  423.      Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
  424.      This is free software, and you are welcome to redistribute it
  425.      under certain conditions; type `show c' for details.
  426.  
  427. The hypothetical commands `show w' and `show c' should show the
  428. appropriate parts of the General Public License. Of course, the
  429. commands you use may be called something other than `show w' and `show
  430. c'; they could even be mouse-clicks or menu items--whatever suits your
  431. program.
  432.  
  433. You should also get your employer (if you work as a programmer) or your
  434. school, if any, to sign a "copyright disclaimer" for the program, if
  435. necessary. Here a sample; alter the names:
  436.  
  437.      Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  438.      `Gnomovision' (which makes passes at compilers) written by James Hacker.
  439.      
  440.      SIGNATURE OF TY COON, 1 April 1989
  441.      Ty Coon, President of Vice
  442.  
  443. This General Public License does not permit incorporating your program
  444. into proprietary programs. If your program is a subroutine library, you
  445. may consider it more useful to permit linking proprietary applications
  446. with the library. If this is what you want to do, use the GNU Library
  447. General Public License instead of this License.
  448.  
  449.  
  450. Introduction
  451. *************
  452.  
  453. ClipTool is basically a storehouse for text you may want to paste into
  454. other programs, perhaps multiple times.
  455.  
  456.  
  457. Options
  458. ********
  459.  
  460. ClipTool understands the following icon tooltypes:
  461.  
  462. `CX_PRIORITY=PRIORITY'
  463.      lets you change the priority of ClipTool relative to other
  464.      Commodities Exchange programs. The default priority is 0. The
  465.      valid range is -128 to 127; the higher the number, the higher the
  466.      priority. This only changes the order in which the Commodities
  467.      gets to look at input events.
  468.  
  469. `CX_POPKEY=HOTKEY STRING'
  470.      specifies the key or keys that must be pressed to pop up ClipTool's
  471.      window. The default is `control lalt c'. Please refer to your
  472.      Workbench manual for a list of valid key combinations.
  473.  
  474. `CX_POPUP=yes|no'
  475.      determines whether the GUI window is opened when ClipTool is
  476.      launched. The default is `yes'. You will probably want to change
  477.      this if you put the program in the `WBStartup' drawer.
  478.  
  479. `EMBOSSED=yes|no'
  480.      Normally ClipTool will use embossed imagery to give its buttonbar
  481.      a 3-D look, unless it is run on a two colour screen. Setting
  482.      EMBOSSED=no forces ClipTool to always use its simpler 2-D imagery.
  483.      This may be useful if your colour preferences make the 3-D buttons
  484.      look strange.
  485.  
  486. `CREATEICONS=yes|no'
  487.      can be used to enable or suppress the creation of icons when data
  488.      is saved to a file. The default is to create icons. This can be
  489.      turned on and off at will.
  490.  
  491. `UNIT=0-255'
  492.      is the clipboard unit to use when ClipTool is launched. It can be
  493.      changed while the program is running. The default is 0.
  494.  
  495. `APPICON=yes|no'
  496.      determines whether ClipTool shall put an AppIcon, a dropbox, on the
  497.      Workbench. The default is `yes'.
  498.  
  499. `PORTNAME=AREXX PORT NAME'
  500.      is used to override the default port name, which is `CLIPTOOL'.
  501.  
  502. When started from the shell, ClipTool accepts arguments corresponding to
  503. the icon tooltypes according to this AmigaDOS template:
  504.  
  505.   
  506. CX_PRIORITY/K/N,CX_POPKEY/K,CX_POPUP/K,EMBOSSED/K,CREATEICONS/K,UNIT/K/N,APPICON/K,PORTNAME/K
  507.  
  508. The case and order of the keywords doesn't matter. The defaults are the
  509. same as when used as tooltypes.
  510.  
  511.  
  512. ARexx Interface
  513. ****************
  514.  
  515.  
  516. ARexx Commands
  517. ===============
  518.  
  519. In this section, each ARexx command is explained following a standard
  520. outline:
  521.  
  522. The format listing shows all the arguments and keywords accepted by the
  523. command. Square brackets enclose arguments and keywords that are
  524. optional. They are accepted by the command but are not required. A
  525. vertical bar is used to separate options of which you may only choose
  526. one.
  527.  
  528. In the command template, each argument is specified by a keyword (a
  529. preset argument that the command understands) followed by a modifier
  530. `/X' where `X' is one of the characters `A', `K', `N', or `S'. Each
  531. keyword can have several of the modifiers. Neither the keywords nor the
  532. modifiers are case-dependent.
  533.  
  534. This is followed by a description of the command.
  535.  
  536.  
  537. OPEN
  538. -----
  539.  
  540. Format: OPEN FILENAME FILE [DIR DIRECTORY]
  541. Template: NAME=FILENAME/K/A,DIR/K
  542.  
  543. This command tries to open the file specified by the FILE argument,
  544. load it, and make it the current buffer. It recognizes IFF FTXT files
  545. automatically.
  546.  
  547. If you specify a relative pathname, ClipTool may not be able to locate
  548. the file, because its current directory may differ from the current
  549. directory of the process that sent the OPEN command. To overcome this
  550. problem, you can use the DIR keyword to tell ClipTool to *temporarily*
  551. change its current directory to DIRECTORY:
  552.  
  553.      'open filename' foo 'dir' pragma('D')
  554.  
  555. The built-in ARexx function `pragma()', with the option `D', returns
  556. the *full* path of the current directory.
  557.  
  558. The keyword NAME is provided as an alternative to the AUISG compliant
  559. FILENAME.
  560.  
  561.  
  562. SAVEAS
  563. -------
  564.  
  565. Format: SAVEAS NAME FILE [FTXT] [DIR DIRECTORY]
  566. Template: NAME/K/A,FTXT/S,DIR/K
  567.  
  568. This command saves the contents of the current buffer to the file
  569. specified by the FILE argument. If the FTXT switch is used, it will be
  570. saved as an IFF FTXT file.
  571.  
  572. If you specify a relative pathname, the result may not be what you
  573. expect, because ClipTool's current directory may differ from the current
  574. directory of the process that sent the SAVEAS command. To overcome this
  575. problem, you can use the DIR keyword to tell ClipTool to *temporarily*
  576. change its current directory to DIRECTORY (for a full example, *note
  577. SaveClip.rexx::.):
  578.  
  579.      'saveas name' foo 'dir' pragma('D')
  580.  
  581. The built-in ARexx function `pragma()', with the option `D', returns
  582. the *full* path of the current directory.
  583.  
  584.  
  585. SHOW
  586. -----
  587.  
  588. Format: SHOW
  589. Template: (none)
  590.  
  591. This command opens ClipTool's main window on the default public screen.
  592. If it is already open, it is moved in front of the other windows on the
  593. screen and made active.
  594.  
  595. SHOW is a synonym for the AUISG compliant command ACTIVATE.
  596.  
  597.  
  598. HIDE
  599. -----
  600.  
  601. Format: HIDE
  602. Template: (none)
  603.  
  604. This command closes ClipTool's main window. It is not an error, if the
  605. window is already closed.
  606.  
  607. HIDE is a synonym for the AUISG compliant command DEACTIVATE.
  608.  
  609.  
  610. ACTIVATE
  611. ---------
  612.  
  613. Format: ACTIVATE
  614. Template: (none)
  615.  
  616. This command opens ClipTool's main window on the default public screen.
  617. If it is already open, it is moved in front of the other windows on the
  618. screen and made active.
  619.  
  620. ACTIVATE is an AUISG compliant synonym for the SHOW command.
  621.  
  622.  
  623. DEACTIVATE
  624. -----------
  625.  
  626. Format: DEACTIVATE
  627. Template: (none)
  628.  
  629. This command closes ClipTool's main window. It is not an error, if the
  630. window is already closed.
  631.  
  632. DEACTIVATE is an AUISG compliant synonym for the HIDE command.
  633.  
  634.  
  635. QUIT
  636. -----
  637.  
  638. Format: QUIT
  639. Template: (none)
  640.  
  641. This command stops ClipTool.
  642.  
  643.  
  644. CUT
  645. ----
  646.  
  647. Format: CUT
  648. Template: (none)
  649.  
  650. This command removes the current buffer and places it in the current
  651. clipboard unit.
  652.  
  653.  
  654. COPY
  655. -----
  656.  
  657. Format: COPY
  658. Template: (none)
  659.  
  660. This command places a duplicate of the current buffer into the current
  661. clipboard unit.
  662.  
  663.  
  664. PASTE
  665. ------
  666.  
  667. Format: PASTE
  668. Template: (none)
  669.  
  670. This command puts the contents of the current clipboard unit into a new
  671. buffer. This buffer is made the current buffer.
  672.  
  673.  
  674. ERASE
  675. ------
  676.  
  677. Format: ERASE
  678. Template: (none)
  679.  
  680. This command removes the current buffer.
  681.  
  682.  
  683. PREVIOUS
  684. ---------
  685.  
  686. Format: PREVIOUS
  687. Template: (none)
  688.  
  689. This command makes the previous buffer the current buffer.
  690.  
  691.  
  692. NEXT
  693. -----
  694.  
  695. Format: NEXT
  696. Template: (none)
  697.  
  698. This command makes the next buffer the current buffer.
  699.  
  700.  
  701. GETNUMBER
  702. ----------
  703.  
  704. Format: GETNUMBER VAR NAME
  705. Template: VAR/K/A
  706.  
  707. Returns the number of clip buffers in the ARexx variable NAME.
  708.  
  709.  
  710. GETCURRENT
  711. -----------
  712.  
  713. Format: GETCURRENT VAR NAME
  714. Template: VAR/K/A
  715.  
  716. Returns the number of the current buffer in the ARexx variable NAME.
  717.  
  718.  
  719. CREATEICONS
  720. ------------
  721.  
  722. Format: CREATEICONS ON|OFF
  723. Template: ON/S,OFF/S
  724.  
  725. This command controls the creation of icons when saving files. One of
  726. the switches must be given.
  727.  
  728.  
  729. GETCREATEICONS
  730. ---------------
  731.  
  732. Format: GETCREATEICONS VAR NAME
  733. Template: VAR/K/A
  734.  
  735. Returns the current state of the `Create icons?' menu item in the ARexx
  736. variable NAME. The state is one of two possible strings: `ON' or `OFF'.
  737. Thus, the contents of NAME can be used as an argument to CREATEICONS
  738. (*note CREATEICONS::.).
  739.  
  740.  
  741. APPICON
  742. --------
  743.  
  744. Format: APPICON ON|OFF
  745. Template: ON/S,OFF/S
  746.  
  747. This command turns the AppIcon on and off.
  748.  
  749.  
  750. GETUNIT
  751. --------
  752.  
  753. Format: GETUNIT VAR NAME
  754. Template: VAR/K/A
  755.  
  756. Returns the clipboard unit number in the ARexx variable NAME.
  757.  
  758.  
  759. SETUNIT
  760. --------
  761.  
  762. Format: SETUNIT NUMBER
  763. Template: /N/A
  764.  
  765. This command sets the clipboard unit to NUMBER.
  766.  
  767.  
  768. Examples
  769. =========
  770.  
  771. This section contains a few example scripts, showing how you may control
  772. ClipTool from ARexx.
  773.  
  774.  
  775. LoadClip.rexx
  776. --------------
  777.  
  778.      /*
  779.       * loadclip - Load a file into the clipboard.
  780.       */
  781.      
  782.      parse arg fname
  783.      address cliptool
  784.      'open filename' fname 'dir' pragma(d)
  785.      'cut'
  786.  
  787.  
  788. SaveClip.rexx
  789. --------------
  790.  
  791.      /*
  792.       * saveclip - Save the contents of the clipboard to a file.
  793.       */
  794.      
  795.      parse arg fname
  796.      address cliptool
  797.      'getnumber var before'
  798.      'paste'
  799.      'getnumber var after'
  800.      if before < after then do
  801.          'getcreateicons var state'
  802.          'createicons off'   /* we don't want an icon */
  803.          'saveas name' fname 'dir' pragma('Directory')
  804.          'erase'
  805.          'createicons' state /* restore the previous state */
  806.      end
  807.      else say 'Clipboard is empty'
  808.  
  809.  
  810. EDCopy.ed
  811. ----------
  812.  
  813.      /*
  814.       * EDCopy - Copy the marked block to the current clipboard unit.
  815.       *   Assumes ClipTool is running.
  816.       *   You can add it to Ed's EDIT menu if you put
  817.       *   the following command in S:Ed-startup:
  818.       *
  819.       *     SI n 2 "Copy to Clipboard" "rx!EDCopy.ed!"
  820.       *
  821.       *   where n is the menu item number.
  822.       *
  823.       *  You can also add it to a key with something like
  824.       *
  825.       *     SF n "rx!EDCopy.ed!"
  826.       *
  827.       *  where n range from 1 to 57. Please refer to the Ed docs for details.
  828.       */
  829.      
  830.      tempfile = 'T:EDCLIP-'pragma('ID')
  831.      options failat 21
  832.      'WB!'tempfile'!' /* Tell Ed to write the block */
  833.      if rc = 0 then do
  834.          address cliptool 'open filename' tempfile
  835.          address cliptool 'cut'
  836.          address command 'delete quiet force' tempfile
  837.          'SM!Copied!'
  838.      end
  839.      else 'SM!No block selected!'
  840.      exit
  841.  
  842.